Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(packages/vkui): add missed "type": "module" #7939

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

inomdzhon
Copy link
Contributor

@inomdzhon inomdzhon commented Nov 13, 2024


Описание

В #7611 у пакета packages/vkui мы удалили поле "main", но при этом "type" остался как commonjs.

Обнаружил это при тестировании v7.0.0-beta.1 в стороннем репозитории при запуске Jest. Из-за "type": "commonjs", он пытается обратиться к полю "main", но так как его нет, тест падает с ошибкой Cannot find module. С "type": "module" такой проблемы не будет, т.к. уже будет обращаться к полю "module".

Изменения

Это повлекло за собой следующие изменения:

  • packages/vkui/shared.config.js – переименование в .mjs не удалось из-за react-styleguidist, который не умеет в ESM, поэтому перенёс содержимое в корневой shared.js, который используется только в папке /styleguide
  • stylelint.config.mjs – заменил импорты из shared.config.js на объявление путей прямо в файле
  • packages/vkui/cssm/postcss.config.jspackages/vkui/cssm/postcss.config.cjs – заменил импорты из shared.config.js на объявление путей прямо в файле
  • packages/vkui/scripts/postcss.jspackages/vkui/scripts/postcss.cjs – заменил импорты из shared.config.js на объявление путей прямо в файле, а также перенёс объявления VKUI_TOKENS_CSS и generateScopedName
  • packages/vkui/tsconfig.json – упростил include, а то было точечное определение файлов
  • packages/vkui/.eslintrc.jspackages/vkui/.eslintrc.cjs, иначе падает с ошибкой ERR_REQUIRE_ESM. Также обнаружилось, что в @vkontakte/vkjs не хватает поля "exports" (см. BREAKING CHANGE: type module vkjs#552)
  • packages/vkui/rspack.styles.config.tspackages/vkui/rspack.styles.config.mjs, т.к. начал падать с ошибкой ERR_UNKNOWN_FILE_EXTENSION
  • packages/vkui/playwright-ct.config.tspackages/vkui/playwright-ct.config.mjs, т.к. Playwright хочет ESM синтаксис для __dirname и импортов JSON, что не соответствует нашему tsconfig.json, а отдельный tsconfig.e2e.json не завёлся. Также перенёс плагины из scripts/postcss.cjs прямо в конфиг, т.к. импорт scripts/postcss.cjs фризит запуск Playwright
  • packages/vkui/jest.config.ts – добавляем @vkontakte/vkjs в transformIgnorePatterns, т.к. библиотека теперь полностью поставляется как ESM (BREAKING CHANGE: type module vkjs#552).

Release notes

Исправления

  • В package.json добавлено пропущенное поле "type": "module"

Зависимости

@inomdzhon inomdzhon added this to the v7.0.0-beta.2 milestone Nov 13, 2024
@inomdzhon inomdzhon self-assigned this Nov 13, 2024
@inomdzhon inomdzhon requested a review from a team as a code owner November 13, 2024 13:56
Это повлекло за собой следующие изменения:

- ~`packages/vkui/shared.config.js`~ – переименование в `.mjs` не удалось из-за **react-styleguidist**, который не умеет в **ESM**, поэтому перенёс в корневой `shared.js`, который используется только в папке `/styleguide`
- `stylelint.config.mjs` – заменил импорты из `shared.config.js` на объявление путей прямо в файле
- `packages/vkui/cssm/postcss.config.js` → `packages/vkui/cssm/postcss.config.cjs` – заменил импорты из `shared.config.js` на объявление путей прямо в файле
- `packages/vkui/scripts/postcss.js` → `packages/vkui/scripts/postcss.cjs` – заменил импорты из `shared.config.js` на объявление путей прямо в файле, а также перенёс объявления `VKUI_TOKENS_CSS` и `generateScopedName`
- `packages/vkui/tsconfig.json` – упростил `include`, а то было точечное определение файлов
- `packages/vkui/.eslintrc.js` → `packages/vkui/.eslintrc.cjs`
- `packages/vkui/rspack.styles.config.ts` → `packages/vkui/rspack.styles.config.mjs` – т.к. начал падать с ошибкой `ERR_UNKNOWN_FILE_EXTENSION`
@inomdzhon inomdzhon force-pushed the imirdzhamolov/fix/packages-vkui-add-type-module branch from 2eb8c2b to 941138e Compare November 13, 2024 14:01
BlackySoul
BlackySoul previously approved these changes Nov 13, 2024
Copy link
Contributor

github-actions bot commented Nov 13, 2024

size-limit report 📦

Path Size
JS 381.64 KB (0%)
JS (gzip) 115.73 KB (0%)
JS (brotli) 95.23 KB (0%)
JS import Div (tree shaking) 1.46 KB (0%)
CSS 332.71 KB (0%)
CSS (gzip) 42.15 KB (0%)
CSS (brotli) 33.24 KB (0%)

Copy link
Contributor

github-actions bot commented Nov 13, 2024

👀 Docs deployed

Commit c210090

Copy link
Contributor

github-actions bot commented Nov 14, 2024

e2e tests

Playwright Report

Copy link
Contributor

@SevereCloud SevereCloud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: 🔧 In progress
Development

Successfully merging this pull request may close these issues.

3 participants